HAL MMC constants migration

This section provides information about the HAL MMC constants migration.

Many constants previously defined in hal_mmc.h are removed from the HAL public APIs. Their definitions are now maintained internally within the HAL and Core drivers, reflecting a design change where such macros are used internally by the HAL implementation rather than being exposed for direct use in application code.

HAL MMC block size constant

HAL1

HAL2 

#define MMC_BLOCKSIZE

In HAL2, this constant has been removed because it is used internally and does not affect user-level operations.

HAL MMC error codes constants

HAL1

HAL2 

#define HAL_MMC_ERROR_NONE
#define HAL_MMC_ERROR_CMD_CRC_FAIL
#define HAL_MMC_ERROR_DATA_CRC_FAIL
#define HAL_MMC_ERROR_CMD_RSP_TIMEOUT
#define HAL_MMC_ERROR_DATA_TIMEOUT
#define HAL_MMC_ERROR_TX_UNDERRUN
#define HAL_MMC_ERROR_RX_OVERRUN
#define HAL_MMC_ERROR_ADDR_MISALIGNED
#define HAL_MMC_ERROR_BLOCK_LEN_ERR
#define HAL_MMC_ERROR_ERASE_SEQ_ERR
#define HAL_MMC_ERROR_BAD_ERASE_PARAM
#define HAL_MMC_ERROR_WRITE_PROT_VIOLATION
#define HAL_MMC_ERROR_LOCK_UNLOCK_FAILED
#define HAL_MMC_ERROR_COM_CRC_FAILED
#define HAL_MMC_ERROR_ILLEGAL_CMD
#define HAL_MMC_ERROR_CARD_ECC_FAILED
#define HAL_MMC_ERROR_CC_ERR
#define HAL_MMC_ERROR_GENERAL_UNKNOWN_ERR
#define HAL_MMC_ERROR_STREAM_READ_UNDERRUN
#define HAL_MMC_ERROR_STREAM_WRITE_OVERRUN
#define HAL_MMC_ERROR_CID_CSD_OVERWRITE
#define HAL_MMC_ERROR_WP_ERASE_SKIP
#define HAL_MMC_ERROR_CARD_ECC_DISABLED
#define HAL_MMC_ERROR_ERASE_RESET
#define HAL_MMC_ERROR_AKE_SEQ_ERR
#define HAL_MMC_ERROR_INVALID_VOLTRANGE
#define HAL_MMC_ERROR_ADDR_OUT_OF_RANGE
#define HAL_MMC_ERROR_REQUEST_NOT_APPLICABLE
#define HAL_MMC_ERROR_PARAM
#define HAL_MMC_ERROR_UNSUPPORTED_FEATURE
#define HAL_MMC_ERROR_BUSY
#define HAL_MMC_ERROR_DMA
#define HAL_MMC_ERROR_TIMEOUT


#define HAL_MMC_ERROR_INVALID_CALLBACK

#define HAL_MMC_ERROR_NONE
#define HAL_MMC_ERROR_CMD_CRC_FAIL
#define HAL_MMC_ERROR_DATA_CRC_FAIL
#define HAL_MMC_ERROR_CMD_RSP_TIMEOUT
#define HAL_MMC_ERROR_DATA_TIMEOUT
#define HAL_MMC_ERROR_TX_UNDERRUN
#define HAL_MMC_ERROR_RX_OVERRUN
#define HAL_MMC_ERROR_ADDR_MISALIGNED
#define HAL_MMC_ERROR_BLOCK_LEN_ERR
#define HAL_MMC_ERROR_ERASE_SEQ_ERR
#define HAL_MMC_ERROR_BAD_ERASE_PARAM
#define HAL_MMC_ERROR_WRITE_PROT_VIOLATION
#define HAL_MMC_ERROR_LOCK_UNLOCK_FAILED
#define HAL_MMC_ERROR_COM_CRC_FAILED
#define HAL_MMC_ERROR_ILLEGAL_CMD
#define HAL_MMC_ERROR_CARD_ECC_FAILED
#define HAL_MMC_ERROR_CC_ERR
#define HAL_MMC_ERROR_GENERAL_UNKNOWN_ERR
#define HAL_MMC_ERROR_STREAM_READ_UNDERRUN
#define HAL_MMC_ERROR_STREAM_WRITE_OVERRUN
#define HAL_MMC_ERROR_CID_CSD_OVERWRITE
#define HAL_MMC_ERROR_WP_ERASE_SKIP
#define HAL_MMC_ERROR_CARD_ECC_DISABLED
#define HAL_MMC_ERROR_ERASE_RESET
#define HAL_MMC_ERROR_AKE_SEQ_ERR
#define HAL_MMC_ERROR_INVALID_VOLTRANGE
#define HAL_MMC_ERROR_ADDR_OUT_OF_RANGE
#define HAL_MMC_ERROR_REQUEST_NOT_APPLICABLE
#define HAL_MMC_ERROR_INVALID_PARAM
#define HAL_MMC_ERROR_UNSUPPORTED_FEATURE
#define HAL_MMC_ERROR_BUSY
#define HAL_MMC_ERROR_DMA
#define HAL_MMC_ERROR_TIMEOUT

Callbacks are handled differently in HAL2. For more details refer to Individual callback registration APIs replace global register and unregister functions.

HAL MMC context identifiers constants

HAL1

HAL2 

#define MMC_CONTEXT_NONE
#define MMC_CONTEXT_READ_SINGLE_BLOCK
#define MMC_CONTEXT_READ_MULTIPLE_BLOCK
#define MMC_CONTEXT_WRITE_SINGLE_BLOCK
#define MMC_CONTEXT_WRITE_MULTIPLE_BLOCK
#define MMC_CONTEXT_IT
#define MMC_CONTEXT_DMA

In HAL2, these constants have been removed because they are used internally and do not affect user-level operations.

HAL MMC voltage range options constants

HAL1

HAL2 

#define MMC_HIGH_VOLTAGE_RANGE
#define MMC_DUAL_VOLTAGE_RANGE
#define MMC_LOW_VOLTAGE_RANGE
#define MMC_INVALID_VOLTAGE_RANGE
#define EMMC_HIGH_VOLTAGE_RANGE
#define EMMC_DUAL_VOLTAGE_RANGE
#define EMMC_LOW_VOLTAGE_RANGE

In HAL2, these constants have been removed because they are used internally and do not affect user-level operations.

HAL MMC card capacity flag constants

HAL1

HAL2 

#define MMC_LOW_CAPACITY_CARD
#define MMC_HIGH_CAPACITY_CARD

In HAL2, these constants have been removed because they are used internally and do not affect user-level operations.

HAL MMC erase type constants

HAL1

HAL2 



#define HAL_MMC_ERASE
#define HAL_MMC_TRIM
#define HAL_MMC_DISCARD
#define HAL_MMC_SECURE_ERASE
#define HAL_MMC_SECURE_TRIM_STEP1
#define HAL_MMC_SECURE_TRIM_STEP2



#define IS_MMC_ERASE_TYPE(TYPE)

typedef enum
{
  HAL_MMC_ERASE_DEFAULT,
  HAL_MMC_ERASE_TRIM,
  HAL_MMC_ERASE_DISCARD,
  HAL_MMC_ERASE_SECURE,
  HAL_MMC_ERASE_SECURE_TRIM_STEP1,
  HAL_MMC_ERASE_SECURE_TRIM_STEP2
} hal_mmc_erase_type_t;

Removed; validation is handled internally through ASSERT_DBG_PARAM.

Related concepts:

HAL MMC secure removal tool options constants

HAL1

HAL2 



#define HAL_MMC_SRT_ERASE
#define HAL_MMC_SRT_WRITE_CHAR_ERASE
#define HAL_MMC_SRT_WRITE_CHAR_COMPL_RANDOM
#define HAL_MMC_SRT_VENDOR_DEFINED



#define IS_MMC_SRT_TYPE(TYPE)

typedef enum
{
  HAL_MMC_SRT_ERASE,
  HAL_MMC_SRT_WRITE_CHAR_ERASE,
  HAL_MMC_SRT_WRITE_CHAR_COMPL_RANDOM,
  HAL_MMC_SRT_VENDOR_DEFINED
} hal_mmc_secure_removal_type_t;

Removed; validation is handled internally through ASSERT_DBG_PARAM.

Related concepts:

HAL MMC boot partition identifiers constants

HAL1

HAL2 



#define HAL_MMC_BOOT_PARTITION1
#define HAL_MMC_BOOT_PARTITION2
#define HAL_MMC_RPMB_PARTITION
#define HAL_MMC_USER_AREA_PARTITION

typedef enum
{
  HAL_MMC_AREA_PARTITION_BOOT_1,
  HAL_MMC_AREA_PARTITION_BOOT_2,
  HAL_MMC_AREA_PARTITION_RPMB,
  HAL_MMC_AREA_PARTITION_USER
} hal_mmc_area_partition_t;

Related concept:

HAL MMC card state identifiers constants

HAL1

HAL2 



#define HAL_MMC_CARD_IDLE
#define HAL_MMC_CARD_READY
#define HAL_MMC_CARD_IDENTIFICATION
#define HAL_MMC_CARD_STANDBY
#define HAL_MMC_CARD_TRANSFER
#define HAL_MMC_CARD_SENDING
#define HAL_MMC_CARD_RECEIVING
#define HAL_MMC_CARD_PROGRAMMING
#define HAL_MMC_CARD_DISCONNECTED
#define HAL_MMC_CARD_BUSTEST
#define HAL_MMC_CARD_SLEEP
#define HAL_MMC_CARD_ERROR

typedef enum
{
  HAL_MMC_CARD_IDLE,
  HAL_MMC_CARD_READY,
  HAL_MMC_CARD_IDENTIFICATION,
  HAL_MMC_CARD_STANDBY,
  HAL_MMC_CARD_TRANSFER,
  HAL_MMC_CARD_SENDING,
  HAL_MMC_CARD_RECEIVING,
  HAL_MMC_CARD_PROGRAMMING,
  HAL_MMC_CARD_DISCONNECTED,
  HAL_MMC_CARD_BUSTEST,
  HAL_MMC_CARD_SLEEP,
  HAL_MMC_CARD_ERROR
} hal_mmc_card_state_t;

Related concept: